-
Notifications
You must be signed in to change notification settings - Fork 30k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fixes #7065: cli help documentation for --debug and --debug-brk #7086
Conversation
added: v6.2.0 | ||
--> | ||
|
||
listen for debugger commands on user specified port. If port is not specified e.g `--debug` then use 5858 as default. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Long line (80 columns max) and sentences should be properly capitalized. The version number is not correct but I don't really remember when they were added.
I'd advise against documenting |
|
Debug-Brk works for 99% of use cases right? Should an edge case stop it Regarding node-debug.1 page, what should go into it? On Wednesday, June 1, 2016, Jeremiah Senkpiel notifications@github.com
|
Yes, because how it works is almost certainly going to change. If it's documented, we risk breaking code that depends on the current behavior. |
makes sense. Thanks for the explanation. So the plan is to Remove debug-brk, and keep --debug right ? Once you confirm, I'll send an update to the PR. On Wed, Jun 1, 2016 at 8:57 AM, Ben Noordhuis notifications@github.com
|
Yes. |
c133999
to
83c7a88
Compare
Looking at the referenced issue #3589 it appears that was solved and closed. With that in mind is --debug-brk still a feature that is going to be cut? I find value in the feature and was hoping to fix the cluster module to properly support it since waiting until a debugger has attached is essential for handling debugging content on start-up and I'm not aware of another way of tackling it. |
This is the fairly old PR.
Not sure about current state of inspect. Is it considered stable and ready
for release?
So should I update my PR for inspect rather than debug right ?
…On Mon, Jan 9, 2017 at 1:56 PM Josh Gavant ***@***.***> wrote:
Oh, I didn't notice this PR and added the CLI docs in the PR for
--inspect-brk: #8979 <#8979>.
@nojvek <https://github.com/nojvek> want to update the rest of the docs
to target "inspect" instead and then land? Thank you!
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#7086 (comment)>, or mute
the thread
<https://github.com/notifications/unsubscribe-auth/AA-JVGtC9rmM0vQsQkd-B2UadcZGT0G_ks5rQq0EgaJpZM4IrEx_>
.
|
@nodejs/v8-inspector ... is this still needed? |
We don't need docs for --debug anymore, but do need to add If we want to write a man page for |
Okay will submit separate PR.
…On Tue, Feb 28, 2017 at 7:50 PM Josh Gavant ***@***.***> wrote:
We don't need docs for --debug anymore, but do need to add --inspect and node
inspect to the same file (./doc/api/cli.md
<https://github.com/nodejs/node/blob/master/doc/api/cli.md>). @nojvek
<https://github.com/nojvek> would be great if you want to do that, I
guess in a new PR. Thank you!
If we want to write a man page for node inspect as proposed above for node
debug I think it belongs in the node-inspect repo
<https://github.com/nodejs/node-inspect>.
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#7086 (comment)>, or mute
the thread
<https://github.com/notifications/unsubscribe-auth/AA-JVIpL-3Ibjz-x-DZSF1xiPx2fr9sxks5rhOsMgaJpZM4IrEx_>
.
|
I assume then that it's ok to close this PR? |
Checklist
Affected core subsystem(s)
doc
Description of change
Cli documentation for --debug and --debug-brk when
node -h
is invoked.cc @Fishrock123